Skip to content

docs: standardize documentation distribution#25

Merged
nicosampler merged 10 commits into
mainfrom
feat/docs_organization
Jun 4, 2026
Merged

docs: standardize documentation distribution#25
nicosampler merged 10 commits into
mainfrom
feat/docs_organization

Conversation

@nicosampler

Copy link
Copy Markdown
Collaborator

Summary

Closes #17

Standardizes the documentation distribution model so README, AGENTS, CLAUDE, and architecture docs each have a clear reader, scope, and placement rule.

Changes

  • Moved canonical agent rules into root AGENTS.md and made CLAUDE.md files compatibility shims.
  • Added delta AGENTS.md/CLAUDE.md files for wallet-service, canton-connect-kit, and dapp/e2e.
  • Added canton-connect-kit/architecture.md and linked it from root architecture docs.
  • Trimmed duplicated setup details from subproject docs and linked shared local-loop instructions upward.

Acceptance criteria

  • Research confirms or revises the proposed distribution model against the actual state of each subproject and any team conventions.
  • The doc-distribution convention is written into a canonical location with one-reader-per-doc, per-file tier rules, and deltas-only guidance.
  • Each existing subproject doc is audited; root-rule duplication is removed or routed upward.
  • AGENTS.md is co-located with every CLAUDE.md and nowhere else.
  • New delta docs are created where warranted, and non-warranted candidates are recorded with reasons.
  • Subproject READMEs link to root setup instead of restating the shared local loop.
  • Root architecture.md stays seam-focused and points to subproject internals instead of duplicating them.

Test plan

Automated tests

  • git diff --cached --check
  • commit hook: commitlint passed; lint-staged had no matching staged files
  • git push --dry-run -u origin feat/docs_organization ran the pre-push TypeScript sweep: carpincho-wallet, dapp/frontend, canton-barebones/wallet-service, canton-connect-kit
  • git push -u origin feat/docs_organization reran the same pre-push TypeScript sweep and passed

Manual verification

Breaking changes

None.

Checklist

  • Self-reviewed my own diff
  • Tests added or updated
  • Docs updated (if applicable)
  • No unrelated changes bundled in

Screenshots

None.

@vercel

vercel Bot commented Jun 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
carpincho-wallet Ready Ready Preview, Comment Jun 4, 2026 5:15pm

Request Review

@nicosampler nicosampler marked this pull request as ready for review June 3, 2026 21:15
Drop references to the deleted src/wc/handlers.ts (WalletConnect events
are now wired via wc/client.ts subscriptions in views/home/useWalletConnectLifecycle.ts),
add the new views/home and utils modules to the structure tree, record the
Sheet center variant, fix the AddAccount-to-AccountsDialog relocation, and
complete the icons.tsx inventory.

@gabitoesmiapodo gabitoesmiapodo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of follow-ups surfaced while reviewing the doc redistribution:

  • dapp/daml/README.md now links to the root deploy dars step (the npm run deploy-dar wrapper) instead of the raw deploy-dar.sh call. That is the documented monorepo idiom, so no change needed; noting only that the invocation form changed, not just its location.

Comment thread dapp/e2e/README.md Outdated
npm run app:dev # terminal 2 — dApp on :3012
```
The full local stack must be running. Follow the root
[quick start](../../README.md#quick-start), including the wallet, dApp, and

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This trim drops the npm run wallet:dev step (Carpincho web UI on :3011). The root quick start's ## wallet section documents only carpincho:build:extension, not wallet:dev, yet the e2e suite drives the web UI at CARPINCHO_URL=http://localhost:3011. Following this link alone won't bring :3011 up. Either keep npm run wallet:dev inline here, or add it to the root README ## wallet section so the link actually covers it.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gabitoesmiapodo e2e test run the wallet from the extension. there is an inconsistency in the docs, I'll push a fix.

@gabitoesmiapodo gabitoesmiapodo self-requested a review June 4, 2026 02:02
Replace the native window.confirm on the unlock screen with a centered
Radix Sheet + DangerConfirm, matching the rest of the app. Reset now
wipes every carpincho-namespaced storage key (theme, auto-lock, runtime
config) and reloads so all providers re-init from a clean slate, instead
of only clearing the vault blob.
…eset

Vault reset only cleared the carpincho localStorage prefix, leaving two
persistence surfaces behind: WalletConnect sessions/pairings/keychain in
its IndexedDB database, and the remembered direct-connected dApp origins
in chrome.storage.session. Both now cleared so no stale state or dApp
connection history survives into the next wallet.

- wipeWalletConnectStorage deletes the WalletConnect IndexedDB database
- clearDirectConnectedOrigins removes the connected-origins session key
- destroyVault orchestrates all wipes and restores React state as a
  fallback in case the reload is a no-op
- wipeAllPersistedData removes keys defensively so one failure cannot
  strand the rest
fix(wallet): radix reset-vault dialog and full data wipe on reset
@nicosampler nicosampler merged commit 1588b36 into main Jun 4, 2026
2 checks passed
@nicosampler nicosampler deleted the feat/docs_organization branch June 4, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize documentation distribution across the monorepo and subprojects

2 participants